KikuGie's Commons

0.3.0

KikuGie's Commons/dev.kikugie.commons.collections/FixedQueue

FixedQueue

class FixedQueue<T>(val capacity: Int) : Queue<T> (source)

A strict queue with the given capacity. The differences from java.util.ArrayDeque are:

The underlying array is not resizeable.
Removal of arbitrary elements is not supported. Elements must be consumed one by one.
Reduced operation overhead for frequent insertions and removals.

Samples

import dev.kikugie.commons.collections.FixedQueue
import dev.kikugie.commons.collections.present
import kotlin.test.assertEquals
import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   val queue = FixedQueue<Int>(4)
queue += listOf(1, 2, 3, 4)

assertFailsWith<IndexOutOfBoundsException> { queue += 5 }
assertFailsWith<UnsupportedOperationException> { queue -= 3 }
assertEquals(1, queue.remove()) 
   //sampleEnd
}

Constructors

constructor(capacity: Int)

Types

FixedQueueIterator

inner class FixedQueueIterator : MutableIterator<T>

Properties

val capacity: Int

open override var size: Int

Functions

open override fun add(e: T?): Boolean

open override fun addAll(elements: Collection<T?>): Boolean

open override fun clear()

open operator override fun contains(element: T?): Boolean

open override fun containsAll(elements: Collection<T?>): Boolean

open override fun element(): T?

operator fun get(index: Int): T

open override fun isEmpty(): Boolean

open operator override fun iterator(): FixedQueue.FixedQueueIterator<T>

open override fun offer(e: T?): Boolean

open override fun peek(): T?

open override fun poll(): T?

open override fun remove(): T

open override fun ~~remove~~(element: T?): Boolean

open override fun ~~removeAll~~(elements: Collection<T?>): Boolean

open override fun ~~retainAll~~(elements: Collection<T?>): Boolean

open override fun toString(): String